ODStorageUnitCursor

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODStorageUnitCursor

Superclasses
ODObject
Subclasses
none

An object of the ODStorageUnitCursor class provides swift focusing on frequently accessed data in a storage unit.

Description
A storage-unit cursor represents a focus context for a storage unit. The focus context can be the entire storage unit, a particular property, or a particular value of a particular property. When the focus context is the entire storage unit, the data of interest includes all properties and all their values. When the focus context is a particular property, the data of interest includes all values of that property. When the focus context is a particular value, the data of interest is the data stream corresponding to that value.
A storage-unit cursor uses a property name, a value type, and a value index to specify its focus context. Methods of the storage-unit cursor allow you to get and set each of these three pieces of information.

To specify the entire storage unit as the focus context, set the property name to kODNULL; set the value type to kODTypeAll and the value index to kODIndexAll.
To specify a property as the focus context, set the property name to the name of the desired property; set the value type to kODTypeAll and the value index to kODIndexAll.
To specify a value as the focus context, set the property name to the name of the property containing the value. You can specify the value by either its type or its index:

To use type, set the value type to the type of the desired value and the value index to 0.
To use index, set the value type to kODNULL and the value index to the index of the desired value.

A storage-unit cursor makes it simple for you to focus the storage unit on the corresponding focus context. Your part creates a storage-unit cursor object by calling its storage unit's CreateCursor (page 676) or CreateCursorWithFocus (page 677) methods. Your part calls its storage unit's FocusWithCursor method (page 685) to focus the storage unit on the focus context represented by a storage-unit cursor.
For more information about storage units, focus contexts, and value indexes, see the ODStorageUnit class description (page 664).

Methods
This section presents summary descriptions of the ODStorageUnitCursor methods, followed by detailed descriptions in alphabetical order.

GetProperty
Gets the property name of this storage-unit cursor.
SetProperty
Sets the property name of this storage-unit cursor.
GetValueIndex
Gets the value index of this storage-unit cursor.
SetValueIndex
Sets the value index of this storage-unit cursor.
GetValueType
Gets the value type of this storage-unit cursor.
SetValueType
Sets the value type of this storage-unit cursor.

Methods
GetProperty
GetValueIndex
GetValueType
SetProperty
SetValueIndex
SetValueType